home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1995 August: Tool Chest / Dev.CD Aug 95 TC / Dev.CD Aug 95 TC.toast / Tool Chest / Interfaces / UniversalInterfaces 2.0 / PInterfaces / Terminals.p < prev    next >
Encoding:
Text File  |  1995-04-18  |  12.2 KB  |  363 lines  |  [TEXT/MPS ]
  1. {
  2.      File:        Terminals.p
  3.  
  4.      Contains:    Communications Toolbox Terminal tool Interfaces.
  5.  
  6.      Version:    Technology:    System 7.5
  7.                  Package:    Universal Interfaces 2.0 in “MPW Latest” on ETO #17
  8.  
  9.      Copyright:    © 1984-1995 by Apple Computer, Inc.
  10.                  All rights reserved.
  11.  
  12.      Bugs?:        If you find a problem with this file, use the Apple Bug Reporter
  13.                  stack.  Include the file and version information (from above)
  14.                  in the problem description and send to:
  15.                      Internet:    apple.bugs@applelink.apple.com
  16.                      AppleLink:    APPLE.BUGS
  17.  
  18. }
  19.  
  20. {$IFC UNDEFINED UsingIncludes}
  21. {$SETC UsingIncludes := 0}
  22. {$ENDC}
  23.  
  24. {$IFC NOT UsingIncludes}
  25.  UNIT Terminals;
  26.  INTERFACE
  27. {$ENDC}
  28.  
  29. {$IFC UNDEFINED __TERMINALS__}
  30. {$SETC __TERMINALS__ := 1}
  31.  
  32. {$I+}
  33. {$SETC TerminalsIncludes := UsingIncludes}
  34. {$SETC UsingIncludes := 1}
  35.  
  36.  
  37. {$IFC UNDEFINED __DIALOGS__}
  38. {$I Dialogs.p}
  39. {$ENDC}
  40. {    Errors.p                                                    }
  41. {        ConditionalMacros.p                                        }
  42. {    Memory.p                                                    }
  43. {        Types.p                                                    }
  44. {        MixedMode.p                                                }
  45. {    Windows.p                                                    }
  46. {        Quickdraw.p                                                }
  47. {            QuickdrawText.p                                        }
  48. {        Events.p                                                }
  49. {            OSUtils.p                                            }
  50. {        Controls.p                                                }
  51. {            Menus.p                                                }
  52. {    TextEdit.p                                                    }
  53.  
  54. {$IFC UNDEFINED __CTBUTILITIES__}
  55. {$I CTBUtilities.p}
  56. {$ENDC}
  57. {    StandardFile.p                                                }
  58. {        Files.p                                                    }
  59. {    AppleTalk.p                                                    }
  60.  
  61. {$IFC UNDEFINED __CONNECTIONS__}
  62. {$I Connections.p}
  63. {$ENDC}
  64.  
  65. {$PUSH}
  66. {$ALIGN MAC68K}
  67. {$LibExport+}
  68.  
  69. CONST
  70. { current Terminal Manager version     }
  71.     curTMVersion                = 2;
  72. { current Terminal Manager Environment Record version     }
  73.     curTermEnvRecVers            = 0;
  74. { error codes    }
  75.     tmGenericError                = -1;
  76.     tmNoErr                        = 0;
  77.     tmNotSent                    = 1;
  78.     tmEnvironsChanged            = 2;
  79.     tmNotSupported                = 7;
  80.     tmNoTools                    = 8;
  81.  
  82.     
  83. TYPE
  84.     TMErr = OSErr;
  85.  
  86.  
  87. CONST
  88.     tmInvisible                    = 1 * (2**(0));
  89.     tmSaveBeforeClear            = 1 * (2**(1));
  90.     tmNoMenus                    = 1 * (2**(2));
  91.     tmAutoScroll                = 1 * (2**(3));
  92.     tmConfigChanged                = 1 * (2**(4));
  93.  
  94.     
  95. TYPE
  96.     TMFlags = LONGINT;
  97.  
  98.  
  99. CONST
  100.     selTextNormal                = 1 * (2**(0));
  101.     selTextBoxed                = 1 * (2**(1));
  102.     selGraphicsMarquee            = 1 * (2**(2));
  103.     selGraphicsLasso            = 1 * (2**(3));
  104.     tmSearchNoDiacrit            = 1 * (2**(8));
  105.     tmSearchNoCase                = 1 * (2**(9));
  106.  
  107.     
  108. TYPE
  109.     TMSearchTypes = INTEGER;
  110.  
  111.     TMSelTypes = INTEGER;
  112.  
  113.  
  114. CONST
  115.     cursorText                    = 1;
  116.     cursorGraphics                = 2;
  117.  
  118.     
  119. TYPE
  120.     TMCursorTypes = INTEGER;
  121.  
  122.  
  123. CONST
  124.     tmTextTerminal                = 1 * (2**(0));
  125.     tmGraphicsTerminal            = 1 * (2**(1));
  126.  
  127.     
  128. TYPE
  129.     TMTermTypes = INTEGER;
  130.  
  131.     TermDataBlock = RECORD
  132.         flags:                    TMTermTypes;
  133.         theData:                Handle;
  134.         auxData:                Handle;
  135.         reserved:                LONGINT;
  136.     END;
  137.  
  138.     TermDataBlockPtr = ^TermDataBlock;
  139.     TermDataBlockH = ^TermDataBlockPtr;
  140.     TermDataBlockHandle = ^TermDataBlockPtr;
  141.  
  142.     TermEnvironRec = RECORD
  143.         version:                INTEGER;
  144.         termType:                TMTermTypes;
  145.         textRows:                INTEGER;
  146.         textCols:                INTEGER;
  147.         cellSize:                Point;
  148.         graphicSize:            Rect;
  149.         slop:                    Point;
  150.         auxSpace:                Rect;
  151.     END;
  152.  
  153.     TermEnvironPtr = ^TermEnvironRec;
  154.  
  155.     TMSelection = RECORD
  156.         CASE INTEGER OF
  157.         0: (
  158.             selRect:                    Rect;
  159.            );
  160.         1: (
  161.             selRgnHandle:                RgnHandle;
  162.            );
  163.     END;
  164.  
  165.     TermPtr = ^TermRecord;
  166.     TermHandle = ^TermPtr;
  167.  
  168.     TerminalSendProcPtr = ProcPtr;  { FUNCTION TerminalSend(thePtr: Ptr; theSize: LONGINT; refCon: LONGINT; flags: CMFlags): LONGINT; }
  169.     TerminalBreakProcPtr = ProcPtr;  { PROCEDURE TerminalBreak(duration: LONGINT; refCon: LONGINT); }
  170.     TerminalCacheProcPtr = ProcPtr;  { FUNCTION TerminalCache(refCon: LONGINT; theTermData: TermDataBlockPtr): LONGINT; }
  171.     TerminalSearchCallBackProcPtr = ProcPtr;  { PROCEDURE TerminalSearchCallBack(hTerm: TermHandle; refNum: INTEGER; VAR foundRect: Rect); }
  172.     TerminalClikLoopProcPtr = ProcPtr;  { FUNCTION TerminalClikLoop(refCon: LONGINT): BOOLEAN; }
  173.     TerminalEnvironsProcPtr = ProcPtr;  { FUNCTION TerminalEnvirons(refCon: LONGINT; VAR theEnvirons: TermEnvironRec): CMErr; }
  174.     TerminalChooseIdleProcPtr = ProcPtr;  { PROCEDURE TerminalChooseIdle; }
  175.     TerminalToolDefProcPtr = ProcPtr;  { FUNCTION TerminalToolDef(hTerm: TermHandle; msg: INTEGER; p1: LONGINT; p2: LONGINT; p3: LONGINT): LONGINT; }
  176.     TerminalSendUPP = UniversalProcPtr;
  177.     TerminalBreakUPP = UniversalProcPtr;
  178.     TerminalCacheUPP = UniversalProcPtr;
  179.     TerminalSearchCallBackUPP = UniversalProcPtr;
  180.     TerminalClikLoopUPP = UniversalProcPtr;
  181.     TerminalEnvironsUPP = UniversalProcPtr;
  182.     TerminalChooseIdleUPP = UniversalProcPtr;
  183.     TerminalToolDefUPP = UniversalProcPtr;
  184.  
  185.     TermRecord = RECORD
  186.         procID:                    INTEGER;
  187.         flags:                    TMFlags;
  188.         errCode:                TMErr;
  189.         refCon:                    LONGINT;
  190.         userData:                LONGINT;
  191.         defProc:                TerminalToolDefUPP;
  192.         config:                    Ptr;
  193.         oldConfig:                Ptr;
  194.         environsProc:            TerminalEnvironsUPP;
  195.         reserved1:                LONGINT;
  196.         reserved2:                LONGINT;
  197.         tmPrivate:                Ptr;
  198.         sendProc:                TerminalSendUPP;
  199.         breakProc:                TerminalBreakUPP;
  200.         cacheProc:                TerminalCacheUPP;
  201.         clikLoop:                TerminalClikLoopUPP;
  202.         owner:                    WindowPtr;
  203.         termRect:                Rect;
  204.         viewRect:                Rect;
  205.         visRect:                Rect;
  206.         lastIdle:                LONGINT;
  207.         selection:                TMSelection;
  208.         selType:                TMSelTypes;
  209.         mluField:                LONGINT;
  210.     END;
  211.  
  212. CONST
  213.     uppTerminalSendProcInfo = $00002FF0; { FUNCTION (4 byte param, 4 byte param, 4 byte param, 2 byte param): 4 byte result; }
  214.     uppTerminalBreakProcInfo = $000003C0; { PROCEDURE (4 byte param, 4 byte param); }
  215.     uppTerminalCacheProcInfo = $000003F0; { FUNCTION (4 byte param, 4 byte param): 4 byte result; }
  216.     uppTerminalSearchCallBackProcInfo = $00000EC0; { PROCEDURE (4 byte param, 2 byte param, 4 byte param); }
  217.     uppTerminalClikLoopProcInfo = $000000D0; { FUNCTION (4 byte param): 1 byte result; }
  218.     uppTerminalEnvironsProcInfo = $000003E0; { FUNCTION (4 byte param, 4 byte param): 2 byte result; }
  219.     uppTerminalChooseIdleProcInfo = $00000000; { PROCEDURE ; }
  220.     uppTerminalToolDefProcInfo = $0000FEF0; { FUNCTION (4 byte param, 2 byte param, 4 byte param, 4 byte param, 4 byte param): 4 byte result; }
  221.  
  222. FUNCTION NewTerminalSendProc(userRoutine: TerminalSendProcPtr): TerminalSendUPP;
  223.     {$IFC NOT GENERATINGCFM }
  224.     INLINE $2E9F;
  225.     {$ENDC}
  226.  
  227. FUNCTION NewTerminalBreakProc(userRoutine: TerminalBreakProcPtr): TerminalBreakUPP;
  228.     {$IFC NOT GENERATINGCFM }
  229.     INLINE $2E9F;
  230.     {$ENDC}
  231.  
  232. FUNCTION NewTerminalCacheProc(userRoutine: TerminalCacheProcPtr): TerminalCacheUPP;
  233.     {$IFC NOT GENERATINGCFM }
  234.     INLINE $2E9F;
  235.     {$ENDC}
  236.  
  237. FUNCTION NewTerminalSearchCallBackProc(userRoutine: TerminalSearchCallBackProcPtr): TerminalSearchCallBackUPP;
  238.     {$IFC NOT GENERATINGCFM }
  239.     INLINE $2E9F;
  240.     {$ENDC}
  241.  
  242. FUNCTION NewTerminalClikLoopProc(userRoutine: TerminalClikLoopProcPtr): TerminalClikLoopUPP;
  243.     {$IFC NOT GENERATINGCFM }
  244.     INLINE $2E9F;
  245.     {$ENDC}
  246.  
  247. FUNCTION NewTerminalEnvironsProc(userRoutine: TerminalEnvironsProcPtr): TerminalEnvironsUPP;
  248.     {$IFC NOT GENERATINGCFM }
  249.     INLINE $2E9F;
  250.     {$ENDC}
  251.  
  252. FUNCTION NewTerminalChooseIdleProc(userRoutine: TerminalChooseIdleProcPtr): TerminalChooseIdleUPP;
  253.     {$IFC NOT GENERATINGCFM }
  254.     INLINE $2E9F;
  255.     {$ENDC}
  256.  
  257. FUNCTION NewTerminalToolDefProc(userRoutine: TerminalToolDefProcPtr): TerminalToolDefUPP;
  258.     {$IFC NOT GENERATINGCFM }
  259.     INLINE $2E9F;
  260.     {$ENDC}
  261.  
  262. FUNCTION CallTerminalSendProc(thePtr: Ptr; theSize: LONGINT; refCon: LONGINT; flags: CMFlags; userRoutine: TerminalSendUPP): LONGINT;
  263.     {$IFC NOT GENERATINGCFM}
  264.     INLINE $205F, $4E90;
  265.     {$ENDC}
  266.  
  267. PROCEDURE CallTerminalBreakProc(duration: LONGINT; refCon: LONGINT; userRoutine: TerminalBreakUPP);
  268.     {$IFC NOT GENERATINGCFM}
  269.     INLINE $205F, $4E90;
  270.     {$ENDC}
  271.  
  272. FUNCTION CallTerminalCacheProc(refCon: LONGINT; theTermData: TermDataBlockPtr; userRoutine: TerminalCacheUPP): LONGINT;
  273.     {$IFC NOT GENERATINGCFM}
  274.     INLINE $205F, $4E90;
  275.     {$ENDC}
  276.  
  277. PROCEDURE CallTerminalSearchCallBackProc(hTerm: TermHandle; refNum: INTEGER; VAR foundRect: Rect; userRoutine: TerminalSearchCallBackUPP);
  278.     {$IFC NOT GENERATINGCFM}
  279.     INLINE $205F, $4E90;
  280.     {$ENDC}
  281.  
  282. FUNCTION CallTerminalClikLoopProc(refCon: LONGINT; userRoutine: TerminalClikLoopUPP): BOOLEAN;
  283.     {$IFC NOT GENERATINGCFM}
  284.     INLINE $205F, $4E90;
  285.     {$ENDC}
  286.  
  287. FUNCTION CallTerminalEnvironsProc(refCon: LONGINT; VAR theEnvirons: TermEnvironRec; userRoutine: TerminalEnvironsUPP): CMErr;
  288.     {$IFC NOT GENERATINGCFM}
  289.     INLINE $205F, $4E90;
  290.     {$ENDC}
  291.  
  292. PROCEDURE CallTerminalChooseIdleProc(userRoutine: TerminalChooseIdleUPP);
  293.     {$IFC NOT GENERATINGCFM}
  294.     INLINE $205F, $4E90;
  295.     {$ENDC}
  296.  
  297. FUNCTION CallTerminalToolDefProc(hTerm: TermHandle; msg: INTEGER; p1: LONGINT; p2: LONGINT; p3: LONGINT; userRoutine: TerminalToolDefUPP): LONGINT;
  298.     {$IFC NOT GENERATINGCFM}
  299.     INLINE $205F, $4E90;
  300.     {$ENDC}
  301.  
  302. FUNCTION InitTM: TMErr;
  303. FUNCTION TMGetVersion(hTerm: TermHandle): Handle;
  304. FUNCTION TMGetTMVersion: INTEGER;
  305. FUNCTION TMNew({CONST}VAR termRect: Rect; {CONST}VAR viewRect: Rect; flags: TMFlags; procID: INTEGER; owner: WindowPtr; sendProc: TerminalSendUPP; cacheProc: TerminalCacheUPP; breakProc: TerminalBreakUPP; clikLoop: TerminalClikLoopUPP; environsProc: TerminalEnvironsUPP; refCon: LONGINT; userData: LONGINT): TermHandle;
  306. PROCEDURE TMDispose(hTerm: TermHandle);
  307. PROCEDURE TMKey(hTerm: TermHandle; {CONST}VAR theEvent: EventRecord);
  308. PROCEDURE TMUpdate(hTerm: TermHandle; visRgn: RgnHandle);
  309. PROCEDURE TMPaint(hTerm: TermHandle; {CONST}VAR theTermData: TermDataBlock; {CONST}VAR theRect: Rect);
  310. PROCEDURE TMActivate(hTerm: TermHandle; activate: BOOLEAN);
  311. PROCEDURE TMResume(hTerm: TermHandle; resume: BOOLEAN);
  312. PROCEDURE TMClick(hTerm: TermHandle; {CONST}VAR theEvent: EventRecord);
  313. PROCEDURE TMIdle(hTerm: TermHandle);
  314. FUNCTION TMStream(hTerm: TermHandle; theBuffer: UNIV Ptr; theLength: LONGINT; flags: CMFlags): LONGINT;
  315. FUNCTION TMMenu(hTerm: TermHandle; menuID: INTEGER; item: INTEGER): BOOLEAN;
  316. PROCEDURE TMReset(hTerm: TermHandle);
  317. PROCEDURE TMClear(hTerm: TermHandle);
  318. PROCEDURE TMResize(hTerm: TermHandle; {CONST}VAR newViewRect: Rect);
  319. FUNCTION TMGetSelect(hTerm: TermHandle; theData: Handle; VAR theType: ResType): LONGINT;
  320. PROCEDURE TMGetLine(hTerm: TermHandle; lineNo: INTEGER; VAR theTermData: TermDataBlock);
  321. PROCEDURE TMSetSelection(hTerm: TermHandle; {CONST}VAR theSelection: TMSelection; selType: TMSelTypes);
  322. PROCEDURE TMScroll(hTerm: TermHandle; dh: INTEGER; dv: INTEGER);
  323. FUNCTION TMValidate(hTerm: TermHandle): BOOLEAN;
  324. PROCEDURE TMDefault(VAR theConfig: Ptr; procID: INTEGER; allocate: BOOLEAN);
  325. FUNCTION TMSetupPreflight(procID: INTEGER; VAR magicCookie: LONGINT): Handle;
  326. PROCEDURE TMSetupSetup(procID: INTEGER; theConfig: UNIV Ptr; count: INTEGER; theDialog: DialogPtr; VAR magicCookie: LONGINT);
  327. FUNCTION TMSetupFilter(procID: INTEGER; theConfig: UNIV Ptr; count: INTEGER; theDialog: DialogPtr; VAR theEvent: EventRecord; VAR theItem: INTEGER; VAR magicCookie: LONGINT): BOOLEAN;
  328. PROCEDURE TMSetupItem(procID: INTEGER; theConfig: UNIV Ptr; count: INTEGER; theDialog: DialogPtr; VAR theItem: INTEGER; VAR magicCookie: LONGINT);
  329. PROCEDURE TMSetupXCleanup(procID: INTEGER; theConfig: UNIV Ptr; count: INTEGER; theDialog: DialogPtr; OKed: BOOLEAN; VAR magicCookie: LONGINT);
  330. PROCEDURE TMSetupPostflight(procID: INTEGER);
  331. FUNCTION TMGetConfig(hTerm: TermHandle): Ptr;
  332. FUNCTION TMSetConfig(hTerm: TermHandle; thePtr: UNIV Ptr): INTEGER;
  333. FUNCTION TMIntlToEnglish(hTerm: TermHandle; inputPtr: UNIV Ptr; VAR outputPtr: Ptr; language: INTEGER): OSErr;
  334. FUNCTION TMEnglishToIntl(hTerm: TermHandle; inputPtr: UNIV Ptr; VAR outputPtr: Ptr; language: INTEGER): OSErr;
  335. PROCEDURE TMGetToolName(id: INTEGER; VAR name: Str255);
  336. FUNCTION TMGetProcID(name: ConstStr255Param): INTEGER;
  337. PROCEDURE TMSetRefCon(hTerm: TermHandle; refCon: LONGINT);
  338. FUNCTION TMGetRefCon(hTerm: TermHandle): LONGINT;
  339. PROCEDURE TMSetUserData(hTerm: TermHandle; userData: LONGINT);
  340. FUNCTION TMGetUserData(hTerm: TermHandle): LONGINT;
  341. FUNCTION TMAddSearch(hTerm: TermHandle; theString: ConstStr255Param; {CONST}VAR where: Rect; searchType: TMSearchTypes; callBack: TerminalSearchCallBackUPP): INTEGER;
  342. PROCEDURE TMRemoveSearch(hTerm: TermHandle; refnum: INTEGER);
  343. PROCEDURE TMClearSearch(hTerm: TermHandle);
  344. FUNCTION TMGetCursor(hTerm: TermHandle; cursType: TMCursorTypes): Point;
  345. FUNCTION TMGetTermEnvirons(hTerm: TermHandle; VAR theEnvirons: TermEnvironRec): TMErr;
  346. FUNCTION TMChoose(VAR hTerm: TermHandle; where: Point; idleProc: TerminalChooseIdleUPP): INTEGER;
  347. PROCEDURE TMEvent(hTerm: TermHandle; {CONST}VAR theEvent: EventRecord);
  348. FUNCTION TMDoTermKey(hTerm: TermHandle; theKey: ConstStr255Param): BOOLEAN;
  349. FUNCTION TMCountTermKeys(hTerm: TermHandle): INTEGER;
  350. PROCEDURE TMGetIndTermKey(hTerm: TermHandle; id: INTEGER; VAR theKey: Str255);
  351. PROCEDURE TMGetErrorString(hTerm: TermHandle; id: INTEGER; VAR errMsg: Str255);
  352.  
  353. {$ALIGN RESET}
  354. {$POP}
  355.  
  356. {$SETC UsingIncludes := TerminalsIncludes}
  357.  
  358. {$ENDC} {__TERMINALS__}
  359.  
  360. {$IFC NOT UsingIncludes}
  361.  END.
  362. {$ENDC}
  363.